GET Outstream Players by Pagination

Overview

---

The following table contains important information about the GET method in regards to receiving the outstream players by pagination.

GET Outstream Players by Pagination
Method	GET
URL or Endpoint	/api/v1/projects/projectId/outstream-players
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	A word you want to filter.
page	Yes	integer	Current page you want to receive.
take	Yes	integer	The number of outstream players to take from the page.
order	Yes	string	The order in which you receive the outstream players (e.g., asc, desc).
insertedDate	No	Date	The date when the players were inserted.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 1,
    "pageSize": 10,
    "totalCount": 1,
    "items": [
      {
        "publicId": "string",
        "name": "string",
        "size": "string",
        "cloudHostedPlayerLibrary": "string",
        "version": "string",
        "orderNumber": 0
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the paginated result object.
currentPage	integer	Returns the current page number in the paginated list of outstream players.
totalPages	integer	The total number of pages.
pageSize	integer	Indicates how many outstream players are per page.
totalCount	integer	The total number of outstream players.
items	array[]	Returns the outstream players on the current page as an array of objects.
publicId	string	The public ID of the outstream player.
name	string	The name of the outstream player.
size	string	The size setting of the outstream player (e.g. Responsive).
cloudHostedPlayerLibrary	string	The URL of the cloud hosted outstream player library.
version	string	The version of the outstream player.
orderNumber	integer or null	Order number of the outstream player.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed